home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / PROGRAM / 4FC10.ARJ / 4COMMENT.DOC next >
Text File  |  1991-11-22  |  7KB  |  135 lines
  1.  
  2.                              4COMMENT     V1.0
  3.                                 11/16/91
  4.                 (c)Copyright Saturn Software & John Bintz
  5.  
  6.      4COMMENT  extracts file descriptions from a bbs list or a formatted
  7.      capture file, matches them to existing files, and installs the
  8.      descriptions:
  9.  
  10.      1. As comments into an achieved file (zip, arj, pak, zoo).
  11.      2. As a description in the 4dos file "descript.ion."
  12.      3. Or into a separate text file.
  13.  
  14.      
  15.      LIMIT OF LIABILITY
  16.         4COMMENT is distributed as is.  The author makes  no representation
  17.      with respect to the fitness of the software for any particular purpose
  18.      and disclaims all warranties, expressed  or implied.  The  author will
  19.      assume no liability for  damages either  from the  direct use  of this
  20.      product or as a consequence of the use of this software.
  21.      
  22.      SHAREWARE
  23.         4COMMENT is distributed as shareware. This  means you  can evaluate
  24.      the product before  you decide  to register  it. If  you are  using it
  25.      after a couple of weeks, you should register it. You can copy 4COMMENT
  26.      or any shareware program and distributed to anyone else, provided that
  27.      neither the program nor the documentation is altered  and that  you do
  28.      not charge a fee. Because  there is  no advertising,  distribution, or
  29.      packaging cost, the price of a shareware program is often less than an
  30.      equivalent package sold through retail channels.
  31.  
  32.         The registration form is provided in a separate file.
  33.      
  34.     SYNTAX:
  35.  
  36.     4COMMENT     Displays help file
  37.  
  38.     4COMMENT DIRN FILEMASK [-c] [-4] [-t]
  39.  
  40.        -c :Installs file description as zip/arj/pak/zoo comment
  41.        -4 :Installs short description in 4dos descript.ion
  42.        -t :Installs file description in text file named "dir" in
  43.            the current subdirectory. If such a file already exists,
  44.            it will be appended to without prior destruction.
  45.            Consequently, 4COMMENT can be run multiple times.
  46.  
  47.        DIRN:  Must be a qualified filename such as J:\DIRS\DIR4 or just
  48.               the filename if it resides in the current subdirectory. It
  49.               contains the descriptions of the files to be processed. The
  50.               file can be a PCB filelist or it can be a captured session
  51.               file. In this version of the program, the routine is not
  52.               very robust. A filename will not be handled correctly, if
  53.               it does not start at the first position of any line, or if
  54.               the filename stem and extension are separated by spaces.
  55.  
  56.        FILEMASK
  57.               Can be a qualified filename or any set of ambiguous characters
  58.               that DOS permits, such as "j:\dl\myfile?.*". The '-t' and '-4'
  59.               options will work regardless of extensions; the '-c' option
  60.               will not because 4COMMENT uses the text of the extension to decide
  61.               what program to shell to. For example, the extension "zip" would
  62.               cause 4COMMENT to shell to pkzip if the '-c' option were in effect.
  63.               If the zipped file was named "myfile.zi1", no shelling would
  64.               take place and no comments would be installed.
  65.  
  66.     Any compression program (PKZIP, ARJ, PAK, ZOO) used must be located
  67.     somewhere on the DOS path for the -c option to operate correctly.
  68.  
  69.  
  70.     4DOS
  71.     4COMMENT processes the "descript.ion" found in the subdirectory specified
  72.     in the filemask, or creates one if none exists.
  73.  
  74.     4COMMENT is compatible with either the 40 character descriptions of V3
  75.     or the 4096 character descriptions of V4. It handles a maximum of
  76.     500 files per directory. However, if there were many files approaching
  77.     the 4096 character comment limit, memory would become a problem before
  78.     the file limit was reached.
  79.  
  80.     In 4DOS, the text of the comment is limited to 40 characters. 4COMMENT takes
  81.     the comment to be the first 40 characters of the description which is
  82.     roughly the equivalents of the first line of a PCB description. However,
  83.     PCB allows 43 characters so there may be some truncation if the text
  84.     file is a PCB dir file or any other file that excedes the 4DOS limits.
  85.  
  86.     If there is a "descript.ion" file, new entries are added corresponding
  87.     to the files processed. If an entry for a file already exists, it is
  88.     replaced by the new description.
  89.  
  90.     4DOS V3 and V4 differ in their handling of entries to "descript.ion". In
  91.     version 3, the entire entry is text and it can be 40 characters long.
  92.     In version 4, extended descriptions are permitted and the entire
  93.     description can be up to 4096 characters long. Only 40 characters are
  94.     displayed and the remainder can be used by other programs for whatever
  95.     purpose. A control 'd', demarks the beginning of each area used by
  96.     another program.
  97.  
  98.     4COMMENT takes this into account whenever there is a new description to a
  99.     file that already exists simply by appending the extended section to the
  100.     new description. There should be no problems, but it has not been tested
  101.     in a real situation since at this date 4dos version 4 has been available
  102.     for about a week and, to my knowledge,  there are no programs which
  103.     take advantage of a control section.
  104.  
  105.     Compressed files
  106.  
  107.     Regardless of the original form of the description, 4COMMENT converts it
  108.     to a PCB type of description and installs the description in that
  109.     format as a comment. All compressed filetypes (zip, arj, pak, zoo) will
  110.     allow multiline comments.
  111.  
  112.     The compressor version worked with are pkzip110, arj222, zoo210, and
  113.     pak210. While I looked at arc601 and lha113, either they didn't allow
  114.     for comments or I didn't discover how to make them work.
  115.  
  116.     Text file
  117.  
  118.     If the text file option is chosen, file entries will be formatted in
  119.     a PCB format and installed in a text file called "dir." That file will
  120.     be located in the subdirectory that 4COMMENT is initiated from, rather than
  121.     in the subdirectory being operated on.
  122.  
  123.     The file is compatible with pcbfiler and should be compatible with any
  124.     other utility that you use to process dir files.
  125.  
  126.  
  127.     Errors
  128.  
  129.     If an error is reported back from one of the compression programs, a
  130.     message is displayed on the screen to the effect that an error occurred
  131.     during the run. A file ("4COMMENT.ERR") is created which specifies the
  132.     file(s) in which there an error occurred.
  133.  
  134.  
  135.